home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
IRIX Base Documentation 1998 November
/
IRIX 6.5.2 Base Documentation November 1998.img
/
usr
/
share
/
catman
/
p_man
/
cat3
/
Xm
/
WMShell.z
/
WMShell
Wrap
Text File
|
1998-10-30
|
29KB
|
463 lines
WWWWMMMMSSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV WWWWMMMMSSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))
NNNNAAAAMMMMEEEE
WWWWMMMMSSSShhhheeeellllllll - The WMShell widget class
SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
#include <Xm/Xm.h>
#include <X11/Shell.h>
VVVVEEEERRRRSSSSIIIIOOOONNNN
This page documents Motif 2.1.
DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
WMShell is a top-level widget that encapsulates the
interaction with the window manager.
CCCCllllaaaasssssssseeeessss
WMShell inherits behavior and resources from the CCCCoooorrrreeee,
CCCCoooommmmppppoooossssiiiitttteeee, and SSSShhhheeeellllllll classes.
The class pointer is _w_m_S_h_e_l_l_W_i_d_g_e_t_C_l_a_s_s.
The class name is WWWWMMMMSSSShhhheeeellllllll.
NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
The following table defines a set of widget resources used
by the programmer to specify data. The programmer can also
set the resource values for the inherited classes to set
attributes for this widget. To reference a resource by name
or by class in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
prefix and use the remaining letters. To specify one of the
defined values for a resource in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove
the XXXXmmmm prefix and use the remaining letters (in either
lowercase or uppercase, but include any underscores between
words). The codes in the access column indicate if the
given resource can be set at creation time (C), set by using
XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
not applicable (N/A).
WWWWMMMMSSSShhhheeeellllllll RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss
XmNbaseHeight XmCBaseHeight int XtUnspecifiedShellInt CSG
XmNbaseWidth XmCBaseWidth int XtUnspecifiedShellInt CSG
XmNheightInc XmCHeightInc int XtUnspecifiedShellInt CSG
XmNiconMask XmCIconMask Pixmap NULL CSG
XmNiconPixmap XmCIconPixmap Pixmap NULL CSG
XmNiconWindow XmCIconWindow Window NULL CSG
XmNiconX XmCIconX int XtUnspecifiedShellInt CSG
XmNiconY XmCIconY int XtUnspecifiedShellInt CSG
XmNinitialState XmCInitialState int NormalState CSG
XmNinput XmCInput Boolean False CSG
XmNmaxAspectX XmCMaxAspectX int XtUnspecifiedShellInt CSG
Page 1 (printed 10/24/98)
WWWWMMMMSSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV WWWWMMMMSSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))
XmNmaxAspectY XmCMaxAspectY int XtUnspecifiedShellInt CSG
XmNmaxHeight XmCMaxHeight int XtUnspecifiedShellInt CSG
XmNmaxWidth XmCMaxWidth int XtUnspecifiedShellInt CSG
XmNminAspectX XmCMinAspectX int XtUnspecifiedShellInt CSG
XmNminAspectY XmCMinAspectY int XtUnspecifiedShellInt CSG
XmNminHeight XmCMinHeight int XtUnspecifiedShellInt CSG
XmNminWidth XmCMinWidth int XtUnspecifiedShellInt CSG
XmNtitle XmCTitle String dynamic CSG
XmNtitleEncoding XmCTitleEncoding Atom dynamic CSG
XmNtransient XmCTransient Boolean False CSG
XmNwaitForWm XmCWaitForWm Boolean True CSG
XmNwidthInc XmCWidthInc int XtUnspecifiedShellInt CSG
XmNwindowGroup XmCWindowGroup Window dynamic CSG
XmNwinGravity XmCWinGravity int dynamic CSG
XmNwmTimeout XmCWmTimeout int 5000 ms CSG
XXXXmmmmNNNNbbbbaaaasssseeeeHHHHeeeeiiiigggghhhhtttt
Specifies the base for a progression of preferred
heights for the window manager to use in sizing
the widget. The preferred heights are
XXXXmmmmNNNNbbbbaaaasssseeeeHHHHeeeeiiiigggghhhhtttt plus integral multiples of
XXXXmmmmNNNNhhhheeeeiiiigggghhhhttttIIIInnnncccc, with a minimum of XXXXmmmmNNNNmmmmiiiinnnnHHHHeeeeiiiigggghhhhtttt and a
maximum of XXXXmmmmNNNNmmmmaaaaxxxxHHHHeeeeiiiigggghhhhtttt. If an initial value is
not supplied for XXXXmmmmNNNNbbbbaaaasssseeeeHHHHeeeeiiiigggghhhhtttt but is supplied for
XXXXmmmmNNNNbbbbaaaasssseeeeWWWWiiiiddddtttthhhh, the value of XXXXmmmmNNNNbbbbaaaasssseeeeHHHHeeeeiiiigggghhhhttttis set to
0 (zero) when the widget is realized.
XXXXmmmmNNNNbbbbaaaasssseeeeWWWWiiiiddddtttthhhh
Specifies the base for a progression of preferred
widths for the window manager to use in sizing the
widget. The preferred widths are XXXXmmmmNNNNbbbbaaaasssseeeeWWWWiiiiddddtttthhhh
plus integral multiples of XXXXmmmmNNNNwwwwiiiiddddtttthhhhIIIInnnncccc, with a
minimum of XXXXmmmmNNNNmmmmiiiinnnnWWWWiiiiddddtttthhhh and a maximum of
XXXXmmmmNNNNmmmmaaaaxxxxWWWWiiiiddddtttthhhh. If an initial value is not supplied
for XXXXmmmmNNNNbbbbaaaasssseeeeWWWWiiiiddddtttthhhh but is supplied for
XXXXmmmmNNNNbbbbaaaasssseeeeHHHHeeeeiiiigggghhhhtttt, the value of XXXXmmmmNNNNbbbbaaaasssseeeeWWWWiiiiddddtttthhhhis set to
0 (zero) when the widget is realized.
XXXXmmmmNNNNhhhheeeeiiiigggghhhhttttIIIInnnncccc
Specifies the increment for a progression of
preferred heights for the window manager to use in
sizing the widget. The preferred heights are
XXXXmmmmNNNNbbbbaaaasssseeeeHHHHeeeeiiiigggghhhhtttt plus integral multiples of
XXXXmmmmNNNNhhhheeeeiiiigggghhhhttttIIIInnnncccc, with a minimum of XXXXmmmmNNNNmmmmiiiinnnnHHHHeeeeiiiigggghhhhtttt and a
maximum of XXXXmmmmNNNNmmmmaaaaxxxxHHHHeeeeiiiigggghhhhtttt. If an initial value is
not supplied for XXXXmmmmNNNNhhhheeeeiiiigggghhhhttttIIIInnnncccc but is supplied for
XXXXmmmmNNNNwwwwiiiiddddtttthhhhIIIInnnncccc, the value of XXXXmmmmNNNNhhhheeeeiiiigggghhhhttttIIIInnnnccccis set to 1
when the widget is realized.
XXXXmmmmNNNNiiiiccccoooonnnnMMMMaaaasssskkkk
Specifies a bitmap that could be used by the
window manager to clip the XXXXmmmmNNNNiiiiccccoooonnnnPPPPiiiixxxxmmmmaaaapppp bitmap to
Page 2 (printed 10/24/98)
WWWWMMMMSSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV WWWWMMMMSSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))
make the icon nonrectangular.
XXXXmmmmNNNNiiiiccccoooonnnnPPPPiiiixxxxmmmmaaaapppp
Specifies a bitmap that could be used by the
window manager as the application's icon.
XXXXmmmmNNNNiiiiccccoooonnnnWWWWiiiinnnnddddoooowwww
Specifies the ID of a window that could be used by
the window manager as the application's icon.
XXXXmmmmNNNNiiiiccccoooonnnnXXXX Specifies a suitable place to put the
application's icon; this is a hint to the window
manager in root window coordinates. Because the
window manager controls icon placement policy,
this resource may be ignored.
XXXXmmmmNNNNiiiiccccoooonnnnYYYY Specifies a suitable place to put the
application's icon; this is a hint to the window
manager in root window coordinates. Because the
window manager controls icon placement policy,
this resource may be ignored.
XXXXmmmmNNNNiiiinnnniiiittttiiiiaaaallllSSSSttttaaaatttteeee
Specifies the state the application wants the
widget instance to start in. It must be one of
the constants NNNNoooorrrrmmmmaaaallllSSSSttttaaaatttteeee or IIIIccccoooonnnniiiiccccSSSSttttaaaatttteeee.
XXXXmmmmNNNNiiiinnnnppppuuuutttt Specifies the application's input model for this
widget and its descendants. The meaning of a True
or False value for this resource depends on the
presence or absence of a WM_TAKE_FOCUS atom in the
WM_PROTOCOLS property:
IIIInnnnppppuuuutttt MMMMooooddddeeeellll XXXXmmmmNNNNiiiinnnnppppuuuutttt WWWWMMMM____TTTTAAAAKKKKEEEE____FFFFOOOOCCCCUUUUSSSS
No input False Absent
Passive True Absent
Locally active True Present
Globally active False Present
For more information on input models, see the X
Consortium Standard _I_n_t_e_r-_C_l_i_e_n_t _C_o_m_m_u_n_i_c_a_t_i_o_n
_C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l (ICCCM).
XXXXmmmmNNNNmmmmaaaaxxxxAAAAssssppppeeeeccccttttXXXX
Specifies the numerator of the maximum aspect
ratio (X/Y) that the application wants the widget
instance to have.
XXXXmmmmNNNNmmmmaaaaxxxxAAAAssssppppeeeeccccttttYYYY
Specifies the denominator of the maximum aspect
ratio (X/Y) that the application wants the widget
instance to have.
Page 3 (printed 10/24/98)
WWWWMMMMSSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV WWWWMMMMSSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))
XXXXmmmmNNNNmmmmaaaaxxxxHHHHeeeeiiiigggghhhhtttt
Specifies the maximum height that the application
wants the widget instance to have.
XXXXmmmmNNNNmmmmaaaaxxxxWWWWiiiiddddtttthhhh
Specifies the maximum width that the application
wants the widget instance to have.
XXXXmmmmNNNNmmmmiiiinnnnAAAAssssppppeeeeccccttttXXXX
Specifies the numerator of the minimum aspect
ratio (X/Y) that the application wants the widget
instance to have.
XXXXmmmmNNNNmmmmiiiinnnnAAAAssssppppeeeeccccttttYYYY
Specifies the denominator of the minimum aspect
ratio (X/Y) that the application wants the widget
instance to have.
XXXXmmmmNNNNmmmmiiiinnnnHHHHeeeeiiiigggghhhhtttt
Specifies the minimum height that the application
wants the widget instance to have.
XXXXmmmmNNNNmmmmiiiinnnnWWWWiiiiddddtttthhhh
Specifies the minimum width that the application
wants the widget instance to have.
XXXXmmmmNNNNttttiiiittttlllleeee Specifies the application name to be displayed by
the window manager. The default is the icon name,
if specified; otherwise, it is the name of the
application. When XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss is called on this
resource, the returned value is a pointer to the
actual resource value and should not be freed.
XXXXmmmmNNNNttttiiiittttlllleeeeEEEEnnnnccccooooddddiiiinnnngggg
Specifies a property type that represents the
encoding of the XXXXmmmmNNNNttttiiiittttlllleeee string. If a language
procedure has been set, the default is None;
otherwise, the default is _X_A__S_T_R_I_N_G. When the
widget is realized, if the value is None, the
corresponding name is assumed to be in the current
locale. The name is passed to
XXXXmmmmbbbbTTTTeeeexxxxttttLLLLiiiissssttttTTTTooooTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyy with an encoding style
of XXXXSSSSttttddddIIIICCCCCCCCTTTTeeeexxxxttttSSSSttttyyyylllleeee. The resulting encoding is
_S_T_R_I_N_Gif the name is fully convertible to _S_T_R_I_N_G;
otherwise it is _C_O_M_P_O_U_N_D__T_E_X_T. The values of the
encoding resources are not changed; they remain
None.
XXXXmmmmNNNNttttrrrraaaannnnssssiiiieeeennnntttt
Specifies a Boolean value that is True if the
widget instance is transient, typically a popup on
behalf of another widget. The window manager may
Page 4 (printed 10/24/98)
WWWWMMMMSSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV WWWWMMMMSSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))
treat a transient widget's window differently from
other windows. For example, a window manager may
not iconify a transient window separately from its
associated application. Applications and users
should not normally alter this resource.
XXXXmmmmNNNNwwwwaaaaiiiittttFFFFoooorrrrWWWWmmmm
When True, specifies that the Intrinsics waits the
length of time given by the XXXXmmmmNNNNwwwwmmmmTTTTiiiimmmmeeeeoooouuuutttt resource
for the window manager to respond to certain
actions before assuming that there is no window
manager present. This resource is altered by the
Intrinsics as it receives, or fails to receive,
responses from the window manager.
XXXXmmmmNNNNwwwwiiiiddddtttthhhhIIIInnnncccc
Specifies the base for a progression of preferred
widths for the window manager to use in sizing the
widget. The preferred widths are XXXXmmmmNNNNbbbbaaaasssseeeeWWWWiiiiddddtttthhhh
plus integral multiples of XXXXmmmmNNNNwwwwiiiiddddtttthhhhIIIInnnncccc, with a
minimum of XXXXmmmmNNNNmmmmiiiinnnnWWWWiiiiddddtttthhhh and a maximum of
XXXXmmmmNNNNmmmmaaaaxxxxWWWWiiiiddddtttthhhh. If an initial value is not supplied
for XXXXmmmmNNNNwwwwiiiiddddtttthhhhIIIInnnncccc but is supplied for XXXXmmmmNNNNhhhheeeeiiiigggghhhhttttIIIInnnncccc,
the value of XXXXmmmmNNNNwwwwiiiiddddtttthhhhIIIInnnnccccis set to 1 when the
widget is realized.
XXXXmmmmNNNNwwwwiiiinnnnddddoooowwwwGGGGrrrroooouuuupppp
Specifies the ID of a window with which this
widget instance is associated. By convention,
this window is the "leader" of a group of windows.
A window manager may treat all windows in a group
in some way; for example, it may always move or
iconify them together.
If no initial value is specified, the value is set
to the window of the first realized ancestor
widget in the parent hierarchy when the widget is
realized. If a value of XXXXttttUUUUnnnnssssppppeeeecccciiiiffffiiiieeeeddddWWWWiiiinnnnddddoooowwwwGGGGrrrroooouuuupppp
is specified, no window group is set.
XXXXmmmmNNNNwwwwiiiinnnnGGGGrrrraaaavvvviiiittttyyyy
Specifies the window gravity for use by the window
manager in positioning the widget. If no initial
value is specified, the value is set when the
widget is realized. If XXXXmmmmNNNNggggeeeeoooommmmeeeettttrrrryyyy is not NULL,
XXXXmmmmNNNNwwwwiiiinnnnGGGGrrrraaaavvvviiiittttyyyy is set to the window gravity
returned by XXXXWWWWMMMMGGGGeeeeoooommmmeeeettttrrrryyyy. Otherwise, XXXXmmmmNNNNwwwwiiiinnnnGGGGrrrraaaavvvviiiittttyyyy
is set to NNNNoooorrrrtttthhhhWWWWeeeessssttttGGGGrrrraaaavvvviiiittttyyyy.
XXXXmmmmNNNNwwwwmmmmTTTTiiiimmmmeeeeoooouuuutttt
Specifies the length of time that the Intrinsics
waits for the window manager to respond to certain
Page 5 (printed 10/24/98)
WWWWMMMMSSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV WWWWMMMMSSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))
actions before assuming that there is no window
manager present. The value is in milliseconds and
must not be negative.
IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
WMShell inherits behavior and resources from the
superclasses described in the following tables. For a
complete description of each resource, refer to the
reference page for that superclass.
SSSShhhheeeellllllll RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss
XmNallowShellResize XmCAllowShellResize Boolean False CG
XmNcreatePopupChildProc XmCCreatePopupChildProc XtCreatePopupChildProc NULL CSG
XmNgeometry XmCGeometry String NULL CSG
XmNoverrideRedirect XmCOverrideRedirect Boolean False CSG
XmNpopdownCallback XmCCallback XtCallbackList NULL C
XmNpopupCallback XmCCallback XtCallbackList NULL C
XmNsaveUnder XmCSaveUnder Boolean False CSG
XmNvisual XmCVisual Visual * CopyFromParent CSG
CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss
XmNchildren XmCReadOnly WidgetList NULL G
XmNinsertPosition XmCInsertPosition XtOrderProc NULL CSG
XmNnumChildren XmCReadOnly Cardinal 0 G
CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss
XmNaccelerators XmCAccelerators XtAccelerators dynamic CSG
XmNancestorSensitive XmCSensitive Boolean dynamic G
XmNbackground XmCBackground Pixel dynamic CSG
XmNbackgroundPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNborderColor XmCBorderColor Pixel XtDefaultForeground CSG
XmNborderPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNborderWidth XmCBorderWidth Dimension 0 CSG
XmNcolormap XmCColormap Colormap dynamic CG
XmNdepth XmCDepth int dynamic CG
XmNdestroyCallback XmCCallback XtCallbackList NULL C
XmNheight XmCHeight Dimension dynamic CSG
XmNinitialResourcesPersistent XmCInitialResourcesPersistent Boolean True C
XmNmappedWhenManaged XmCMappedWhenManaged Boolean True CSG
XmNscreen XmCScreen Screen * dynamic CG
XmNsensitive XmCSensitive Boolean True CSG
XmNtranslations XmCTranslations XtTranslations dynamic CSG
XmNwidth XmCWidth Dimension dynamic CSG
XmNx XmCPosition Position 0 CSG
XmNy XmCPosition Position 0 CSG
TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
There are no translations for WMShell.
Page 6 (printed 10/24/98)
WWWWMMMMSSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV WWWWMMMMSSSShhhheeeellllllll((((lllliiiibbbbrrrraaaarrrryyyy ccccaaaallllllll))))
RRRREEEELLLLAAAATTTTEEEEDDDD
CCCCoooommmmppppoooossssiiiitttteeee(3), CCCCoooorrrreeee(3), and SSSShhhheeeellllllll(3).
Page 7 (printed 10/24/98)